GetBinaryValue(DicomElement,byte[],int,int) Method

Summary

Updates a buffer with the binary value of the specified data element.

Syntax

C++

Java

public bool GetBinaryValue( 
   DicomElement element, 
   byte[] value, 
   int offset, 
   int length 
)

Public Overloads Function GetBinaryValue( _ 
   ByVal element As DicomElement, _ 
   ByVal value() As Byte, _ 
   ByVal offset As Integer, _ 
   ByVal length As Integer _ 
) As Boolean

public boolean getBinaryValue(DicomElement element, byte[]value, int offset, int length)

public: 
bool GetBinaryValue(  
   DicomElement^ element, 
   array<byte>^ value, 
   int offset, 
   int length 
)

Parameters

element
An item in the Data Set.

value
Buffer that will be updated with the binary value associated with the specified item in the Data Set. You are responsible for allocating the memory for this buffer.

offset
Offset from the beginning of the buffer, at which writing will start.

length
Number of bytes, from the binary value, to write to the buffer.

Return Value

true if the method was able to update the buffer with the binary value; otherwise, false.

Remarks

Note: You must allocate the memory for value. If the length specified by the DicomElement.Length property is greater than [length](" id="lengthparameterlink" class="popuplink.html), then the binary value copied to the buffer will be truncated to the smaller length. If the length specified by DicomElement.Length is less than [length](" id="lengthparameterlink" class="popuplink.html), then the entire binary value of element will be copied to the buffer.

This method can be called for every Value Representation, and it will return the exact value in the Value Field (unconverted).

Example

For an example, refer to SetIntValue.

Requirements

Target Platforms